Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

irc: versionadded notes + Optional annotation migration #2642

Merged
merged 2 commits into from
Nov 13, 2024
Merged

Conversation

dgw
Copy link
Member

@dgw dgw commented Nov 11, 2024

Description

This takes care of #2602 as far as what directly prompted me to slot it into the 8.0.1 milestone, with new versionadded annotations in the docstrings of stuff that's new-ish (added in 7.x or later). I figure after this PR, that issue can become a general checklist of which submodules have been looked at again since 8.0.0 and live un-milestoned for a while.

Maybe we should also have a tracking issue for the second half of this PR, which starts the process of something we talked about in other patches: Replacing use of typing.Optional with | None. Right now I think "just migrate the files you touch" is better than a "touch ALL the things!" PR, but we still should keep track of what's been done.

Checklist

  • I have read CONTRIBUTING.md
  • I can and do license this contribution under the EFLv2
  • No issues are reported by make qa (runs make lint and make test)
    • Ran make lint only locally, as no runtime code is touched
  • I have tested the functionality of the things this change touches

dgw added 2 commits November 10, 2024 18:00
Might as well migrate as we touch things. I just updated some docstring
stuff in `irc/__init__.py`, and as long as I'm in the file let's get rid
of the `typing.Optional` import, too.
@dgw dgw added Documentation Housekeeping Code cleanup, removal of deprecated stuff, etc. labels Nov 11, 2024
@dgw dgw added this to the 8.0.1 milestone Nov 11, 2024
@dgw dgw requested a review from a team November 11, 2024 15:48
Copy link
Contributor

@Exirel Exirel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's a lot of work to track everything down to its version of origin. Well done!

@dgw dgw merged commit 7a605d9 into master Nov 13, 2024
17 checks passed
@dgw dgw deleted the versionadded-irc branch November 13, 2024 17:52
dgw added a commit that referenced this pull request Nov 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Housekeeping Code cleanup, removal of deprecated stuff, etc.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants